/**
 * gwt-validator 
 *
 * Copyright (C) 2006  Nikolaus Rumm, Christian Simonutti
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package gwt.validator.client.action;

import gwt.validator.client.exception.ValidationIssue;

/**
 * <code>Action</code>s represent code snippets that are performed after the
 * validation state has been determined.
 * 
 * They can be seen as <quote>post-processors</quote> of the validation
 * process.
 * 
 * A typical example is the <code>SetMessageAction</code> that displays the
 * validation issue's message using an error label.
 * 
 * @author <a href="mailto:nikolaus.rumm@gmail.com">Nikolaus Rumm</a>
 */
public interface Action {

	/**
	 * Callback method that will be called by the framework in case of a
	 * validation without any issues.
	 */
	public void onSuccess();

	/**
	 * Callback method that will be called by the framework in case that there
	 * was a validation issue.
	 * 
	 * @param aIssue
	 *            The validation issue
	 */
	public void onFailure(ValidationIssue aIssue);

	/**
	 * Resets the action's state.
	 * 
	 * This method must be implemented by all stateful actions in order to
	 * initialize itself between the validation cycles.
	 * 
	 * The method will be called by the validator at the beginning of every
	 * validation cycle.
	 */
	public void reset();
}
